<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxCapsuleGeometry Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxCapsuleGeometry.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classPxCapsuleGeometry-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxCapsuleGeometry Class Reference<div class="ingroups"><a class="el" href="group__geomutils.html">Geomutils</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Class representing the geometry of a capsule.  
 <a href="classPxCapsuleGeometry.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxCapsuleGeometry_8h_source.html">PxCapsuleGeometry.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxCapsuleGeometry:</div>
<div class="dyncontent">
<div class="center"><img src="classPxCapsuleGeometry__inherit__graph.png" border="0" usemap="#PxCapsuleGeometry_inherit__map" alt="Inheritance graph"/></div>
<map name="PxCapsuleGeometry_inherit__map" id="PxCapsuleGeometry_inherit__map">
<area shape="rect" id="node2" href="classPxGeometry.html" title="A geometry object. " alt="" coords="29,5,124,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxCapsuleGeometry:</div>
<div class="dyncontent">
<div class="center"><img src="classPxCapsuleGeometry__coll__graph.png" border="0" usemap="#PxCapsuleGeometry_coll__map" alt="Collaboration graph"/></div>
<map name="PxCapsuleGeometry_coll__map" id="PxCapsuleGeometry_coll__map">
<area shape="rect" id="node2" href="classPxGeometry.html" title="A geometry object. " alt="" coords="29,5,124,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5764bb1f327ae431aaf875560930e41f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#a5764bb1f327ae431aaf875560930e41f">PxCapsuleGeometry</a> ()</td></tr>
<tr class="memdesc:a5764bb1f327ae431aaf875560930e41f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor, initializes to a capsule with zero height and radius.  <a href="#a5764bb1f327ae431aaf875560930e41f">More...</a><br /></td></tr>
<tr class="separator:a5764bb1f327ae431aaf875560930e41f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb685e9dca4cb99658783dc348901998"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#aeb685e9dca4cb99658783dc348901998">PxCapsuleGeometry</a> (PxReal radius_, PxReal halfHeight_)</td></tr>
<tr class="memdesc:aeb685e9dca4cb99658783dc348901998"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, initializes to a capsule with passed radius and half height.  <a href="#aeb685e9dca4cb99658783dc348901998">More...</a><br /></td></tr>
<tr class="separator:aeb685e9dca4cb99658783dc348901998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b7658a01ed66c48e8d7967fc99fcb61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#ga5b7658a01ed66c48e8d7967fc99fcb61">isValid</a> () const</td></tr>
<tr class="memdesc:ga5b7658a01ed66c48e8d7967fc99fcb61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the geometry is valid.  <a href="group__geomutils.html#ga5b7658a01ed66c48e8d7967fc99fcb61">More...</a><br /></td></tr>
<tr class="separator:ga5b7658a01ed66c48e8d7967fc99fcb61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#a681b898f104db56c0012fe8f7f172d15">getType</a> () const</td></tr>
<tr class="memdesc:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the geometry.  <a href="classPxGeometry.html#a681b898f104db56c0012fe8f7f172d15">More...</a><br /></td></tr>
<tr class="separator:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac4f07af35bc86338c5bd01e11266dadd"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#ac4f07af35bc86338c5bd01e11266dadd">radius</a></td></tr>
<tr class="memdesc:ac4f07af35bc86338c5bd01e11266dadd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The radius of the capsule.  <a href="#ac4f07af35bc86338c5bd01e11266dadd">More...</a><br /></td></tr>
<tr class="separator:ac4f07af35bc86338c5bd01e11266dadd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5affd7d085f89d0a90a35b97214cc40"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#af5affd7d085f89d0a90a35b97214cc40">halfHeight</a></td></tr>
<tr class="memdesc:af5affd7d085f89d0a90a35b97214cc40"><td class="mdescLeft">&#160;</td><td class="mdescRight">half of the capsule's height, measured between the centers of the hemispherical ends.  <a href="#af5affd7d085f89d0a90a35b97214cc40">More...</a><br /></td></tr>
<tr class="separator:af5affd7d085f89d0a90a35b97214cc40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:a2507c9f4d63fe816968fe9a2744ac549 inherit pro_methods_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#a2507c9f4d63fe816968fe9a2744ac549">PxGeometry</a> (<a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a> type)</td></tr>
<tr class="separator:a2507c9f4d63fe816968fe9a2744ac549 inherit pro_methods_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:af24eeb8078fbd12e17206029b52a45b6 inherit pro_attribs_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#af24eeb8078fbd12e17206029b52a45b6">mType</a></td></tr>
<tr class="separator:af24eeb8078fbd12e17206029b52a45b6 inherit pro_attribs_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class representing the geometry of a capsule. </p>
<p>Capsules are shaped as the union of a cylinder of length 2 * halfHeight and with the given radius centered at the origin and extending along the x axis, and two hemispherical ends. </p><dl class="section note"><dt>Note</dt><dd>The scaling of the capsule is expected to be baked into these values, there is no additional scaling parameter.</dd></dl>
<p>The function PxTransformFromSegment is a helper for generating an appropriate transform for the capsule from the capsule's interior line segment.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#ga60805c0463b00baf463d5281e034a141" title="creates a transform from the endpoints of a segment, suitable for an actor transform for a PxCapsuleG...">PxTransformFromSegment</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5764bb1f327ae431aaf875560930e41f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5764bb1f327ae431aaf875560930e41f">&#9670;&nbsp;</a></span>PxCapsuleGeometry() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxCapsuleGeometry::PxCapsuleGeometry </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default constructor, initializes to a capsule with zero height and radius. </p>

</div>
</div>
<a id="aeb685e9dca4cb99658783dc348901998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb685e9dca4cb99658783dc348901998">&#9670;&nbsp;</a></span>PxCapsuleGeometry() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxCapsuleGeometry::PxCapsuleGeometry </td>
          <td>(</td>
          <td class="paramtype">PxReal&#160;</td>
          <td class="paramname"><em>radius_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&#160;</td>
          <td class="paramname"><em>halfHeight_</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor, initializes to a capsule with passed radius and half height. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af5affd7d085f89d0a90a35b97214cc40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5affd7d085f89d0a90a35b97214cc40">&#9670;&nbsp;</a></span>halfHeight</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal PxCapsuleGeometry::halfHeight</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>half of the capsule's height, measured between the centers of the hemispherical ends. </p>

<p class="reference">Referenced by <a class="el" href="classPxMassProperties.html#acc8eadc90e93df0e25d4dfb63988a596">PxMassProperties::PxMassProperties()</a>.</p>

</div>
</div>
<a id="ac4f07af35bc86338c5bd01e11266dadd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4f07af35bc86338c5bd01e11266dadd">&#9670;&nbsp;</a></span>radius</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal PxCapsuleGeometry::radius</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The radius of the capsule. </p>

<p class="reference">Referenced by <a class="el" href="classPxMassProperties.html#acc8eadc90e93df0e25d4dfb63988a596">PxMassProperties::PxMassProperties()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxCapsuleGeometry_8h_source.html">PxCapsuleGeometry.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxCapsuleGeometry.html">PxCapsuleGeometry</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
